home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / UTILITY / CMDED2E6.ARJ / HISTORY.ASM < prev    next >
Assembly Source File  |  1992-06-30  |  10KB  |  403 lines
  1. ; HISTORY.ASM
  2. ; (c) 1989, 1990 Ashok P. Nadkarni
  3. ;
  4. ; This module implements the history feature of the cmdedit program.
  5. ; DFA stopped lines of length less than min_length being stored on stack
  6. ; (December 1990).
  7. ; WD made history stack cyclic and allowed display of current history.
  8.  
  9.     INCLUDE    common.inc
  10.     INCLUDE    buffers.inc
  11.  
  12.     PUBLIC    hist_top
  13.     PUBLIC    hist_init
  14.     PUBLIC    hist_fwd
  15.     PUBLIC    hist_back
  16.     PUBLIC    hist_fwd_match
  17.     PUBLIC    hist_bck_match
  18.     PUBLIC    remember
  19.     PUBLIC    hist_type
  20.     PUBLIC    execute_auto_recall
  21.     PUBLIC    execute_rsthist
  22.     PUBLIC    execute_histstat
  23.     PUBLIC    hist_ptr
  24.     PUBLIC    history
  25.  
  26. CSEG    SEGMENT    PARA PUBLIC 'CODE'
  27.  
  28.  
  29.     EXTRN    linebuf:BYTE        ;line buffer
  30.     EXTRN    lastchar:WORD
  31.     EXTRN    dot:WORD        ;current position in line buffer
  32.     EXTRN    min_length:WORD     ;added by dfa
  33.  
  34.  
  35. ; The history stack is maintained as a string stack using the functions in
  36. ; the string stack library. The top and bottom of the stack are always
  37. ; zero length strings (the bottom is always a zero length sentinel
  38. ; implemented by the string stack package but the top is explicitly 
  39. ; maintained by the history code.
  40. history    $string_stack 2 DUP (<>)    ;Buffer descriptors
  41. hist_ptr    DW    ?        ;Ptr to current buffer descriptor
  42.  
  43. DGROUP    GROUP    CSEG
  44.  
  45.     EXTRN    bell:PROC
  46.     EXTRN    set_disp_marks:PROC
  47.     EXTRN    erase_to_dot:PROC
  48.  
  49.     ASSUME    CS:DGROUP,DS:DGROUP,ES:DGROUP,SS:DGROUP
  50.  
  51.  
  52. ;+
  53. ; FUNCTION : hist_init
  54. ;
  55. ; Initializes the various data structures associated with the
  56. ; command history buffers. CALLER MUST ENSURE PASSED ADDRESSES ARE VALID
  57. ; AND BUFFER IS LARGE ENOUGH.
  58. ;
  59. ; Parameters:
  60. ;    AX     - length of buffer in bytes
  61. ;    BX    - address of buffer
  62. ;    CX    - 0 if DOS buffer, any other value if application buffer
  63. ; 
  64. ; Returns:
  65. ;    Nothing.
  66. ; Registers destroyed : BX,CX
  67. ;-
  68. hist_init proc    near
  69.     push    bx
  70.     mov    bx,offset DGROUP:history ;bx := address of buffer descriptors
  71.     jcxz    @hist_init_1        ;if DOS, bx OK
  72.     add    bx,TYPE $string_stack    ;else point to application descriptor
  73. @hist_init_1:
  74.     xchg    ax,cx            ;CX = buffer size
  75.     pop    ax            ;AX = Buffer address
  76.                     ;BX points to appropriate descriptor
  77.     call    near ptr strstk_init    ;Initialize buffer and descriptor
  78.     xor    al,al            ;Push a zero length string onto stack
  79.     mov    cl,1            ;Force onto stack
  80.     call    near ptr strstk_push    ;Assumes no errors
  81.     ret
  82. hist_init    endp
  83.  
  84.  
  85. ;+
  86. ; FUNCTION : execute_rsthist
  87. execute_rsthist proc    near
  88.     mov    bx,offset DGROUP:history ;bx := address of buffer descriptors
  89.     jcxz    @execute_rsthist_1    ;if DOS, bx OK
  90.     add    bx,TYPE $string_stack    ;else point to application descriptor
  91. @execute_rsthist_1:
  92.     call    near ptr strstk_reset    ;Initialize buffer and descriptor
  93.     xor    al,al            ;Push a zero length string onto stack
  94.     mov    cl,1            ;Force onto stack
  95.     call    near ptr strstk_push    ;Assumes no errors
  96.     ret
  97. execute_rsthist    endp
  98.  
  99.  
  100.  
  101. ;+
  102. ; FUNCTION : hist_type
  103. ;
  104. ;    Sets the hist_ptr global to point at the descriptor for the
  105. ;    current caller (DOS or application).
  106. ;
  107. ; Parameters:
  108. ;    CX =    0 if DOS, anything else for application
  109. ;
  110. ; Returns:
  111. ;    Nothing.
  112. ; Registers destroyed : BX
  113. ;-
  114. hist_type proc near
  115.     mov    bx,offset DGROUP:history ;address of first descriptor
  116.     mov    hist_ptr,bx
  117.     ret
  118. hist_type endp
  119.  
  120.  
  121. ;+
  122. ; FUNCTION : hist_top
  123. ;
  124. ;    Resets the history pointer to the null string at top of history stack.
  125. ;    The line buffer itslef is NOT changed.
  126. ; Parameters:
  127. ;    None.
  128. ;
  129. ; Returns:
  130. ;    Nothing.
  131. ; Registers destroyed:  BX
  132. ;-
  133. hist_top proc near
  134.     mov    bx,hist_ptr        ;Point to current descriptor
  135.     call    near ptr strstk_settop    ;Set to top of history stack.
  136.  
  137.     ret
  138. hist_top endp
  139.  
  140.  
  141. ;+
  142. ; FUNCTION : hist_back
  143. ;
  144. ;    Gets the previous history line (if there is one) and stores it
  145. ;    in the line buffer. Also makes it the current line.
  146. ;
  147. ; Parameters:
  148. ;    None.
  149. ;
  150. ; Returns:
  151. ;    Nothing.
  152. ; Registers destroyed: AX,BX,CX
  153. ;-
  154. hist_back proc near
  155.     mov    dot,offset DGROUP:linebuf
  156.     jmp    hist_bck_match        ;Will return to caller
  157. hist_back endp
  158.  
  159.  
  160.  
  161. ;+
  162. ; FUNCTION : hist_fwd
  163. ;
  164. ;    Gets the next history line (if there is one) and stores it
  165. ;    in the line buffer. Also makes it the current line.
  166. ;
  167. ; Parameters:
  168. ;    None.
  169. ;
  170. ; Returns:
  171. ;    Nothing.
  172. ; Registers destroyed :
  173. ;-
  174. hist_fwd proc near
  175.     mov    dot,offset DGROUP:linebuf
  176.     jmp    hist_fwd_match        ;Will return to caller
  177. hist_fwd endp
  178.  
  179.  
  180.  
  181. ;+
  182. ; 
  183. ; FUNCTION : hist_copy
  184. ;
  185. ;    Copies the current history line into the line buffer. The dot
  186. ;    is set to the beginning of the line.
  187. ;
  188. ; Parameters:
  189. ;    None.          (fixed these comments -- wd)
  190. ;
  191. ; Returns:
  192. ;    Nothing.
  193. ;    Sets lastchar to end of new history line.
  194. ;
  195. ; Registers destroyed: AX,BX,CX,DX
  196. ;-
  197. hist_copy proc near
  198.     mov    bx,hist_ptr    ;Current descriptor
  199.     mov    ax,offset DGROUP:linebuf ;the history line storage
  200.     push    ax        ;Remember
  201. ;    mov    dot,ax    ;Cursor will be at the beginning of line (removed--wd)
  202.     xchg    ax,dx        ;dx->first char in line (parameter)
  203.     mov    ax,lastchar    ;ax->upper limit (parameter)
  204.     call    near ptr set_disp_marks ;Indicate changed range
  205.                 ;No registers destroyed
  206.     mov    ax,dx        ;Restore beginning of line
  207.     mov    cx,LINEBUF_SIZE    ;cx<-max length of line (fixed this -- wd)
  208.     push    cx        ;Save it
  209.     call    near ptr strstk_copy ;Copy history line into linebuf
  210.                 ;AX == length of history string
  211.     pop    cx        ;
  212.     jnc    @hist_copy_90    ;Jump if no error from strstk_copy
  213.     call    near ptr bell    ;History line too long for buffer
  214.     mov    ax,cx        ;Number of bytes = max length of line
  215. @hist_copy_90:
  216.     pop    dx        ;dx->beginning of line
  217.     add    ax,dx        ;ax->end
  218.     mov    lastchar,ax    ;Update end of line
  219.     call    near ptr set_disp_marks ;Indicate changed range
  220.     ret
  221. hist_copy endp
  222.  
  223.  
  224.  
  225. ;+
  226. ; 
  227. ; FUNCTION : remember
  228. ;
  229. ;    Saves the line buffer in the history area. If the line already
  230. ;    exists, it is moved to the top of the stack.
  231. ;   Added by dfa:  lines less than min_length are ignored.
  232. ;
  233. ; Parameters:
  234. ;    None.
  235. ;
  236. ; Returns:
  237. ;    Nothing.
  238. ;
  239. ; Registers destroyed:
  240. ;    AX,BX,CX,DX
  241. ;-
  242. remember proc near
  243.     mov    bx,hist_ptr        ;Descriptor
  244.     call    near ptr strstk_settop    ;Reset stack pointer
  245.     mov    ax,offset DGROUP:linebuf ;AX->line to be stored
  246.     mov    cx,lastchar
  247.     sub    cx,ax            ;CX<-length of line
  248.     cmp    cx,min_length        ;these two lines added by dfa
  249.     jb    @remember_20         ;ignore request if line too short
  250.     call    near ptr strstk_bck_find ;Look for it in history
  251. ;                      buffer. Note that if it is a
  252. ;                      null string, the sentinel at
  253. ;                      top of the stack is not found
  254. ;                      which is at it should be.
  255.     jc    @remember_10        ;Not in stack
  256.     call    near ptr strstk_kill    ;If found delete it from stack
  257. @remember_10:
  258.     call    near ptr strstk_settop    ;Point to sentinel at top of stack
  259.     call    near ptr strstk_kill    ;Delete it
  260.     mov    dx,offset DGROUP:linebuf ;String to be remembered
  261.     mov    ax,lastchar        ;Length of string
  262.     sub    ax,dx            ;AX(AL)<-length of string
  263.     mov    cl,1            ;Force the push
  264.     call    near ptr strstk_push    ;ignore success/fail status
  265.     xor    ax,ax            ;Zero length sentinel
  266.     mov    cl,1
  267.     call    near ptr strstk_push    ;Push it
  268. @remember_20:                ; label added by dfa
  269.     ret
  270. remember endp
  271.  
  272.  
  273.  
  274. ;+
  275. ; 
  276. ; FUNCTION : hist_fwd_match, hist_bck_match
  277. ;
  278. ;    Looks fwd/back thru the history buffer starting from the current
  279. ;    history location looking for a line whose first n chracters match
  280. ;    the n characters before the current position in the line buffer.
  281. ;
  282. ; Parameters:
  283. ;    None.
  284. ;
  285. ; Returns:
  286. ;    CF    = 0 if match found
  287. ;          1 if no match
  288. ;
  289. ; Registers destroyed:
  290. ;-
  291. hist_match proc near
  292. hist_fwd_match LABEL near
  293.     mov    dx,offset DGROUP:strstk_fwd_match
  294.  
  295. ; wd added following 10 lines
  296.     mov    bx,hist_ptr
  297.     mov    ax,[bx].cur
  298.     cmp    ax,[bx].top    ;If the history pointer is at the end,
  299.     jne    @hist_match_10
  300.     mov    ax,[bx].low_end    ;reset it to the start before going forward
  301.     inc    ax
  302.     mov    [bx].cur,ax    ;Set current pointer
  303.     push    dx
  304.     call    near ptr bell
  305.     pop    dx
  306.  
  307.     jmp    short @hist_match_10
  308. hist_bck_match label near
  309.     mov    dx,offset DGROUP:strstk_bck_match
  310. @hist_match_10:  ; (wd reorganized this section)
  311.     mov    bx,hist_ptr    ;Descriptor address
  312.     mov    ax,offset DGROUP:linebuf ;start of pattern
  313.     mov    cx,dot        ;Current position in linebuffer
  314.     sub    cx,ax        ;Number of chars to match
  315.     push    cx        ;Save
  316.     call    dx        ;Will set CF if no match, else sets
  317.                 ; 'current' to matched string & AX to len
  318.     pop    cx        ;Restore count
  319.     jc    @hist_match_20    ;No match
  320.  
  321.     cmp    ax,cx       ;Line must be longer than the search string
  322.     je    @hist_match_10    ;...otherwise, try again (wd)
  323.     call    near ptr hist_copy ;Copy and display the history line
  324.     clc            ;Indicate we matched
  325.     jmp    short @hist_match_99 ; exit
  326.  
  327. @hist_match_20:
  328.     mov    ax,lastchar    ;AX->end-of-line
  329.     call    erase_to_dot    ;Else delete remaining chars in the
  330. ;                 line (chars between AX and dot)
  331.     stc            ;Indicate no match
  332. @hist_match_99:
  333.     ret
  334. hist_match endp
  335.  
  336.  
  337.  
  338. ;+
  339. ; FUNCTION : execute_auto_recall
  340. ;
  341. ;    This function looks backward through the history buffer for a
  342. ;    line with a prefix that matches the characters to the left of
  343. ;    the dot. The search begins with the CURRENT history line. ie.
  344. ;    if the current history line has a matching prefix, the current
  345. ;    pointer is not changed. If no match is found, the history stack
  346. ;    is reset.
  347. ;
  348. ; Parameters:
  349. ;    None.
  350. ;
  351. ; Returns:
  352. ;    CF    = 0 if match found
  353. ;          1 if no match
  354. ; Register(s) destroyed:
  355. ;    AX,BX,CX,DX
  356. ;-
  357. execute_auto_recall proc near
  358.     mov    bx,hist_ptr        ;BX->current history stack descriptor
  359.     mov    ax,offset DGROUP:linebuf ;AX->pattern
  360.     mov    cx,dot
  361.     sub    cx,ax            ;CX<-length of pattern
  362.     call    near ptr strstk_prefix    ;Current history line matches?
  363.     jne    @execute_auto_recall_50    ;No
  364.     clc                ;Yes, current line matches
  365.     jmp    short @execute_auto_recall_99
  366.  
  367. @execute_auto_recall_50:
  368.     call    near ptr hist_bck_match    ;Search backward
  369.     jnc    @execute_auto_recall_99    ;Found a match
  370. ;    No match, reset history stack pointer
  371.     mov    bx,hist_ptr        ;BX->current history stack descriptor
  372.     call    near ptr hist_top    ;Reset history stack
  373.     stc                ;Indicate no match
  374. @execute_auto_recall_99:
  375.     ret
  376. execute_auto_recall endp
  377.  
  378.  
  379. ;+
  380. ; FUNCTION : execute_histstat by wd
  381. ;
  382. ;    This function outputs the entire history buffer from oldest to newest.
  383. ;
  384. ; Parameters:
  385. ;    SI  -> first char in linebuf following this command
  386. ;    CX  == remaining num chars in the line
  387. ;
  388. ; Returns:
  389. ;    Nothing.
  390. ;
  391. ; Register(s) destroyed:
  392. ;    AX,BX,CX,DX
  393. ;-
  394. execute_histstat proc near
  395.     mov    bx,hist_ptr    ;BX->history stack descriptor
  396.     call    near ptr strstk_output
  397.     ret
  398. execute_histstat endp
  399.  
  400. CSEG    ENDS
  401.  
  402.     END
  403.